home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Meeting Pearls 4
/
Meeting Pearls Vol. IV (1996)(GTI - Schatztruhe)[!].iso
/
Pearls
/
libs
/
bgui
/
Docs
/
infoclass.doc
< prev
next >
Wrap
Text File
|
1995-04-23
|
4KB
|
125 lines
File: infoclass.doc
Description: Infoclass documentation.
Copyright: (C) Copyright 1994-1995 Jaba Development.
(C) Copyright 1994-1995 Jan van den Baard.
All Rights Reserved.
------------------------------------------------------------------------------
TABLE OF CONTENTS
infoclass/--background--
infoclass/Methods
infoclass/Attributes
infoclass/--background-- infoclass/--background--
NAME
Class: infoclass
Superclass: baseclass
Include File: <libraries/bgui.h>
FUNCTION
To provide a general multi-line text gadget which can be used for
on-line help or general information purposes. It has the ability to
handle different text style, colors and text justifications. Also
C-style formatting codes are allowed.
A good example of the usage of this class is the BGUI_RequestA()
routine. This routine uses an infoclass object to display the body
text.
This gadget does not send out notification events.
infoclass/Methods infoclass/Methods
NEW METHODS
None.
CHANGED METHODS
None.
infoclass/Attributes infoclass/Attributes
NAME
INFO_TextFormat -- ( STRPTR )
FUNCTION
Set the textual contents of the gadget object. You can use C-style
formatting codes in the text and in addition to that you may also use
any of the following command sequences:
\33b - Bold text.
\33i - Italics text.
\33u - Underlined text.
\33n - Normal text.
\33c - Center this and the following lines.
\33l - Left-justify this and the following lines.
\33r - Right-justify this and the following lines.
\33d<n> - Set drawinfo pen <n>.
\33p<n> - Set pen <n>.
\n - Start a new line of text.
Please note the the \33c, \33l and \33r command sequences can only be
used at the beginning of a new line.
NOTE: Since V38 of the library it is possible to use locale's
FormatString() formatting codes. Locale specific formatting
codes will only work when the locale.library is available.
Default is NULL. Applicability is (ISU).
SEE ALSO
<intuition/screens.h>, exec.library/RawDoFmt(), INFO_Args
NAME
INFO_Args -- ( ULONG * )
FUNCTION
Set the arguments accoording to the C-style formatting codes found in
the text.
Default is NULL. Applicability is (ISU).
SEE ALSO
exec.library/RawDoFmt(), INFO_TextFormat
NAME
INFO_MinLines -- ( ULONG )
FUNCTION
Set the minimum number of lines the object should display at all
times. This is taken into consideration when to object it's minimum
size is calculated.
Default is 1. Applicability is (I).
SEE ALSO
INFO_FixTextWidth
NAME
INFO_FixTextWidth -- ( BOOL )
FUNCTION
To tell the object that it's minimum width may not be smaller than the
width of the longest line in the text plus the offsets and border
thickness.
Default is FALSE. Applicability is (I).
SEE ALSO
INFO_HorizOffset, INFO_VertOffset, INFO_MinLines
NAME
INFO_HorizOffset, INFO_VertOffset -- ( ULONG )
FUNCTION
Set the horizontal and vertical offset from the object borders at
which the text is rendered.
Defaults are 8 horizontally and 6 vertically. Applicability is (I).
SEE ALSO
INFO_FixTextWidth